Hanami backend/fi.aalto.cs.hanami.feedback

Package-level declarations

Types

CreatedDocument

@Serializable

data class CreatedDocument(val id: String, val updatedAtMillis: Long)

CreateDocumentOutcome

sealed interface CreateDocumentOutcome

Result of validating, stamping, and storing a new feedback document.

DisabledMailer

object DisabledMailer : Mailer

DocumentRecord

data class DocumentRecord(val id: String, val studentId: Long, val authorUserId: Long, val content: String, val updatedAtMillis: Long)

DocumentRow

data class DocumentRow(val id: String, val content: String, val updatedAtMillis: Long)

DocumentSummary

@Serializable

data class DocumentSummary(val id: String, val studentId: Long, val authorUserId: Long, val title: String, val commentCount: Int, val blockTypes: List<String>, val hasContent: Boolean, val sharedWithStudent: Boolean, val updatedAtMillis: Long)

EmailResult

@Serializable

data class EmailResult(val sent: Boolean, val recipients: List<String>, val updatedAtMillis: Long? = null)

FeedbackService

class FeedbackService : AutoCloseable

Coordinates authorized feedback documents, profile lookup, and email delivery.

FeedbackStaffMember

@Serializable

data class FeedbackStaffMember(val userId: Long, val username: String, val fullName: String?, val role: Role, val languages: List<String>, val feedbackTags: List<String>, val gradingTags: List<String>)

Mailer

interface Mailer : AutoCloseable

MailSendException

class MailSendException(cause: Throwable) : RuntimeException

MailUnavailableException

class MailUnavailableException : RuntimeException

SendEmailBody

@Serializable

data class SendEmailBody(val subject: String, val html: String, val documentId: String? = null, val expectedUpdatedAtMillis: Long? = null)

SendFeedbackCommand

data class SendFeedbackCommand(val studentId: Long, val documentId: String?, val expectedUpdatedAtMillis: Long?, val subject: String, val html: String)

Describes one feedback email and the document revision it may publish.

SendFeedbackOutcome

sealed interface SendFeedbackOutcome

Result of resolving recipients, checking the document revision, and sending feedback.

SentFeedbackEmail

data class SentFeedbackEmail(val recipients: List<String>, val updatedAtMillis: Long?)

SharedDocumentResponse

@Serializable

data class SharedDocumentResponse(val id: String, val updatedAtMillis: Long, val document: JsonElement)

SmtpMailer

class SmtpMailer(host: String, port: Int, from: String, user: String? = null, password: String? = null, startTls: Boolean = false) : Mailer

SmtpSettings

data class SmtpSettings(val host: String, val port: Int, val from: String, val user: String?, val password: String?, val startTls: Boolean)

StoredAplusFeedbackSource

@Serializable

data class StoredAplusFeedbackSource(val type: StoredFeedbackSourceType, val submissionId: Long, val href: String, val quote: String, val prefix: String, val suffix: String, val occurrence: Long)

StoredCommentBlock

@Serializable

@SerialName(value = "comment")

data class StoredCommentBlock(val id: String, val content: String, val staffOnly: Boolean? = null, val source: StoredAplusFeedbackSource? = null, val authorUserId: Long? = null) : StoredDocumentBlock

StoredDocumentBlock

@Serializable

sealed interface StoredDocumentBlock

StoredDocumentContract

@Serializable

data class StoredDocumentContract(val encoding: StoredDocumentEncoding, val studentId: String, val title: String, val sharedWithStudent: Boolean? = null, val blocks: List<StoredDocumentBlock>, val fileAnnotations: Map<String, List<StoredSarifResult>>)

StoredDocumentEncoding

@Serializable

enum StoredDocumentEncoding : Enum<StoredDocumentEncoding>

StoredFeedbackSourceType

@Serializable

enum StoredFeedbackSourceType : Enum<StoredFeedbackSourceType>

StoredFileBlock

@Serializable

@SerialName(value = "file")

data class StoredFileBlock(val id: String, val ref: StoredFileReference) : StoredDocumentBlock

StoredFileReference

@Serializable

data class StoredFileReference(val weekId: Long, val module: String, val filename: String, val exerciseId: Long, val submissionId: Long)

StoredSarifArtifactLocation

@Serializable

data class StoredSarifArtifactLocation(val uri: String, val uriBaseId: String? = null)

StoredSarifLocation

@Serializable

data class StoredSarifLocation(val physicalLocation: StoredSarifPhysicalLocation)

StoredSarifMessage

@Serializable

data class StoredSarifMessage(val text: String, val markdown: String? = null)

StoredSarifPhysicalLocation

@Serializable

data class StoredSarifPhysicalLocation(val artifactLocation: StoredSarifArtifactLocation, val region: StoredSarifRegion? = null)

StoredSarifRegion

@Serializable

data class StoredSarifRegion(val startLine: Long, val startColumn: Long? = null, val endLine: Long? = null, val endColumn: Long? = null, val snippet: StoredSarifSnippet? = null)

StoredSarifResult

@Serializable

data class StoredSarifResult(val ruleId: String, val kind: String? = null, val level: String? = null, val message: StoredSarifMessage, val locations: List<StoredSarifLocation>? = null, val fingerprints: Map<String, String>? = null, val properties: JsonObject? = null)

StoredSarifSnippet

@Serializable

data class StoredSarifSnippet(val text: String)

StudentDocument

data class StudentDocument(val record: DocumentRecord, val shared: Boolean, val content: String)

UpdateDocumentOutcome

sealed interface UpdateDocumentOutcome

Result of an ownership-checked optimistic document update.

VisibleDocumentResponse

@Serializable

data class VisibleDocumentResponse(val id: String, val studentId: Long, val authorUserId: Long, val sharedWithStudent: Boolean, val updatedAtMillis: Long, val document: JsonElement)

Functions

toSharedDocumentResponse

fun Pair<DocumentRow, JsonElement>.toSharedDocumentResponse(): SharedDocumentResponse

toVisibleDocumentResponse

fun StudentDocument.toVisibleDocumentResponse(): VisibleDocumentResponse